<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>phpDocumentor » \api</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/api.html"><i class="icon-folder-open"></i> api</a></li>
<li><a href="../packages/css.html"><i class="icon-folder-open"></i> css</a></li>
<li><a href="../packages/img.html"><i class="icon-folder-open"></i> img</a></li>
<li><a href="../packages/inc.html"><i class="icon-folder-open"></i> inc</a></li>
<li><a href="../packages/js.html"><i class="icon-folder-open"></i> js</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method_cleanse" title="cleanse :: Cleanse the given input string for use in an SQL query."><span class="description">Cleanse the given input string for use in an SQL query.</span><pre>cleanse()</pre></a></li>
<li class="method public "><a href="#method_create_200_state" title="create_200_state :: Creates a default 200 state in an array."><span class="description">Creates a default 200 state in an array.</span><pre>create_200_state()</pre></a></li>
<li class="method public "><a href="#method_create_401_state" title="create_401_state :: Creates a default 401 state in an array."><span class="description">Creates a default 401 state in an array.</span><pre>create_401_state()</pre></a></li>
<li class="method public "><a href="#method_create_404_state" title="create_404_state :: Creates a default 404 state in an array."><span class="description">Creates a default 404 state in an array.</span><pre>create_404_state()</pre></a></li>
<li class="method public "><a href="#method_get_current_timestamp" title="get_current_timestamp :: Get the current timestamp from the MySQL server."><span class="description">Get the current timestamp from the MySQL server.</span><pre>get_current_timestamp()</pre></a></li>
<li class="method public "><a href="#method_get_enum_types" title="get_enum_types :: Get the enum types for the given column in the given table in an array."><span class="description">Get the enum types for the given column in the given table in an array.</span><pre>get_enum_types()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties
                    <ul><li class="property public "><a href="#property_passwordHolder" title="$passwordHolder :: The default password text holder."><span class="description"></span><pre>$passwordHolder</pre></a></li></ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\api"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/api.html">api</a>
</li>
</ul>
<div class="element class">
<p class="short_description">A static class to contain the api.inc.php functions.</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:rctoris@wpi.edu">Russell Toris</a></td>
</tr>
<tr>
<th>copyright</th>
<td>2013 Russell Toris, Worcester Polytechnic Institute</td>
</tr>
<tr>
<th>license</th>
<td><a href="">BSD -- see LICENSE file</a></td>
</tr>
<tr>
<th>version</th>
<td>April, 11 2013</td>
</tr>
<tr>
<th>package</th>
<td><a href="../packages/api.html">api</a></td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a id="method_cleanse"></a><div class="element clickable method public method_cleanse" data-toggle="collapse" data-target=".method_cleanse .collapse">
<h2>Cleanse the given input string for use in an SQL query.</h2>
<pre>cleanse(string $input, boolean $html, boolean $sprintf) : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will perform
things such as escape character checks and HTML scrubbing (if enabled).
By default, the string is formated for use in an sprintf static function
(i.e., percetange signs are esacped by '%%').</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$input</h4>
<code>string</code><p>The input string to cleanse</p></div>
<div class="subelement argument">
<h4>$html</h4>
<code>boolean</code><p>If HTML scrubbing (conversion to HTML entities)
    should be performed (default = true)</p>
</div>
<div class="subelement argument">
<h4>$sprintf</h4>
<code>boolean</code><p>If percentage signs should be esacped for use in
    a sprintf static function (default = true)</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The cleansed string</div>
</div></div>
</div>
<a id="method_create_200_state"></a><div class="element clickable method public method_create_200_state" data-toggle="collapse" data-target=".method_create_200_state .collapse">
<h2>Creates a default 200 state in an array.</h2>
<pre>create_200_state(object $data) : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This includes a 'true' in the
'ok' element, 'Success.' in the 'msg' element, and $data in the 'data'
element. The header is also changed to the 200 state.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$data</h4>
<code>object</code><p>The data to place in the 'data' element of the array</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>The filled array</div>
</div></div>
</div>
<a id="method_create_401_state"></a><div class="element clickable method public method_create_401_state" data-toggle="collapse" data-target=".method_create_401_state .collapse">
<h2>Creates a default 401 state in an array.</h2>
<pre>create_401_state() : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This includes a 'false' in the
'ok' element, 'Insufficient authorization.' in the 'msg' element, and
null in the 'data' element. The header is also changed to the 401 state.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>The filled array</div>
</div></div>
</div>
<a id="method_create_404_state"></a><div class="element clickable method public method_create_404_state" data-toggle="collapse" data-target=".method_create_404_state .collapse">
<h2>Creates a default 404 state in an array.</h2>
<pre>create_404_state(string $msg) : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This includes a 'false' in the
'ok' element, the given error message in the 'msg' element, and null in
the 'data' element. The header is also changed to the 404 state.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$msg</h4>
<code>string</code><p>The message to put in the array</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>The filled array</div>
</div></div>
</div>
<a id="method_get_current_timestamp"></a><div class="element clickable method public method_get_current_timestamp" data-toggle="collapse" data-target=".method_get_current_timestamp .collapse">
<h2>Get the current timestamp from the MySQL server.</h2>
<pre>get_current_timestamp() : string</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The current timestamp from the MySQL server</div>
</div></div>
</div>
<a id="method_get_enum_types"></a><div class="element clickable method public method_get_enum_types" data-toggle="collapse" data-target=".method_get_enum_types .collapse">
<h2>Get the enum types for the given column in the given table in an array.</h2>
<pre>get_enum_types(string $table, string $column) : array</pre>
<div class="labels"><span class="label">Static</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>the name of the MySQL table</p></div>
<div class="subelement argument">
<h4>$column</h4>
<code>string</code><p>the column name inside of the given table</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>An array containing the enum types for the given column in
    the given table</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_passwordHolder"> </a><div class="element clickable property public property_passwordHolder" data-toggle="collapse" data-target=".property_passwordHolder .collapse">
<h2></h2>
<pre>$passwordHolder : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
            generated on 2013-04-16T13:14:58-07:00.<br></footer></div>
</div>
</body>
</html>
